'\" t
.\"     Title: bugle-log
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: July 2009
.\"    Manual: Bugle user manual
.\"    Source: BUGLE 0.0.20150628
.\"  Language: English
.\"
.TH "BUGLE\-LOG" "7" "July 2009" "BUGLE 0.0.20150628" "Bugle user manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bugle-log \- configure logging output from other filter\-sets
.SH "SYNOPSIS"
.sp
.nf
filterset log
{
    filename "\fIbugle\&.log\fR"
    file_level "\fI4\fR"
    stdout_level "\fI0\fR"
    stderr_level "\fI3\fR"
    flush "\fIno\fR"
    format "\fI[%l] %f\&.%e: %m\fR"
}
.fi
.SH "DESCRIPTION"
.PP
The log filter\-set does not do any logging itself; instead, it provides logging services to other filter\-sets\&. It is always loaded, but it may be explicitly listed in the configuration file to set options\&. The log is always written to standard error, but it can be written to file as well\&. It is also possible to control the log level\&.
.SH "OPTIONS"
.PP
\fBfilename\fR
.RS 4
This sets the file for logging\&. Logging is still done to standard error\&. Note that with the default settings, the file log is more verbose than the standard error log\&.
.RE
.PP
\fBfile_level\fR
.RS 4
The log level for the log file, where a higher number means more verbose logging\&. The levels are:
.PP
0
.RS 4
No logging at all
.RE
.PP
1
.RS 4
Errors, usually leading to immediate termination
.RE
.PP
2
.RS 4
Warnings, usually affecting
bugle\*(Aqs functionality
.RE
.PP
3
.RS 4
Notices, usually OpenGL errors or undefined behaviour
.RE
.PP
4
.RS 4
Info from filtersets that generate logs, such as
\fBbugle-trace\fR(7)
.RE
.PP
5
.RS 4
Debugging messages
.RE
.RE
.PP
\fBstdout_level\fR, \fBstderr_level\fR
.RS 4
Similar to
\fBfile_level\fR, but for logging to standard output and standard error\&. The defaults are 4 for a file, 0 (no logging) for standard out, and 3 for standard error\&.
.RE
.PP
\fBformat\fR
.RS 4
Overrides the default log format\&. The following printf\-style escapes are recognised:
.PP
%l
.RS 4
log level
.RE
.PP
%f
.RS 4
filter\-set
.RE
.PP
%e
.RS 4
event
.RE
.PP
%m
.RS 4
the log message itself
.RE
.PP
%p
.RS 4
process ID
.RE
.PP
%t
.RS 4
thread ID
.RE
.PP
%%
.RS 4
a literal
%
.RE
.RE
.SH "AUTHOR"
.PP
bugle
is written and maintained by
Bruce Merry\&.
.SH "SEE ALSO"
.PP
\fBbugle\fR(3),
\fBbugle-trace\fR(7),
\fBbugle-logstats\fR(7)
